<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Zapmenot Documentation &mdash; Zapmenot 0.1 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/sphinx_highlight.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Licence &amp; Disclaimer" href="license.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="#" class="icon icon-home"> Zapmenot
          </a>
              <div class="version">
                0.1
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence &amp; Disclaimer</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">Material Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="isotopes.html">Isotope Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="modeling.html">Modeling in ZapMeNot</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Generating Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="graphics.html">We Want Pictures!</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory-and-methods.html">Theory and Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarking</a></li>
<li class="toctree-l1"><a class="reference internal" href="module-docs.html">Module Contents</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer</a></li>
<li class="toctree-l1"><a class="reference internal" href="version-history.html">Version History</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">Zapmenot</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="#" class="icon icon-home"></a></li>
      <li class="breadcrumb-item active">Zapmenot Documentation</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="zapmenot-documentation">
<h1>Zapmenot Documentation<a class="headerlink" href="#zapmenot-documentation" title="Permalink to this heading"></a></h1>
<p><cite>ZapMeNot</cite> is a Python library of functions for point-kernel photon shielding analyses.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence &amp; Disclaimer</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#quickstart">Quickstart</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">Material Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="isotopes.html">Isotope Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="modeling.html">Modeling in ZapMeNot</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Generating Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="results.html#basic-method">Basic Method</a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#getting-details">Getting Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="graphics.html">We Want Pictures!</a><ul>
<li class="toctree-l2"><a class="reference internal" href="graphics.html#graphics-from-a-zapmenot-python-script">Graphics from a ZapMeNot Python Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphics.html#graphics-in-a-jupyterlab-notebook">Graphics in a JupyterLab Notebook</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphics.html#going-headless-for-fun-and-profit">Going Headless For Fun and Profit</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="theory-and-methods.html">Theory and Methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="theory-and-methods.html#point-kernel-method">Point-Kernel Method</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory-and-methods.html#uncollided-photon-exposure-rate">Uncollided Photon Exposure Rate</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory-and-methods.html#buildup-factors">Buildup Factors</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory-and-methods.html#quadrature">Quadrature</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory-and-methods.html#multiple-photon-energies">Multiple Photon Energies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarking</a><ul>
<li class="toctree-l2"><a class="reference internal" href="benchmarks.html#ansi-ans-6-6-1-benchmark-i-1">ANSI/ANS 6.6.1 Benchmark I.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmarks.html#ansi-ans-6-6-1-benchmark-ii-1">ANSI/ANS 6.6.1 Benchmark II.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmarks.html#esis-benchmark-problem-1">ESIS Benchmark Problem 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmarks.html#esis-benchmark-problem-2">ESIS Benchmark Problem 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmarks.html#synthetic-benchmark-problem">Synthetic Benchmark Problem</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="module-docs.html">Module Contents</a><ul>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.isotope">ZapMeNot Isotope</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.material">ZapMeNot Material</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.ray">ZapMeNot Ray</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.detector">ZapMeNot Detector</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.shield">ZapMeNot Shield</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.source">ZapMeNot Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-docs.html#module-zapmenot.model">ZapMeNot Model</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#unit-tests">Unit Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#benchmark-tests">Benchmark Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#graphics-tests">Graphics Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#coverage">Coverage</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#updating-a-version">Updating A Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#updating-copyright">Updating Copyright</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="version-history.html">Version History</a></li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="license.html" class="btn btn-neutral float-right" title="Licence &amp; Disclaimer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2019 - 2023, Alan Ford..
      <span class="lastupdated">Last updated on Feb 12, 2023.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>